import Vue from 'vue'
import Router from 'vue-router'

//首先从Vue和vue-router导入必要的依赖，并通过Vue.use(Router)安装vue-router插件。
/**
 * 此脚本主要用于Vue项目的路由配置，通过区分公共路由和动态路由实现了不同层级的访问控制。
 * 同时，通过对Vue Router默认行为的修改，提高了用户体验，避免了不必要的错误提示。
 * 这种设计使得前端应用可以根据用户的权限展示不同的界面，增强了系统的灵活性和安全性。
 */

Vue.use(Router)

/* Layout */
import Layout from '@/layout'

/**
 * Note: 路由配置项
 *
 * hidden: true                     // 当设置 true 的时候该路由不会再侧边栏出现 如401，login等页面，或者如一些编辑页面/edit/1
 * alwaysShow: true                 // 当你一个路由下面的 children 声明的路由大于1个时，自动会变成嵌套的模式--如组件页面
 *                                  // 只有一个时，会将那个子路由当做根路由显示在侧边栏--如引导页面
 *                                  // 若你想不管路由下面的 children 声明的个数都显示你的根路由
 *                                  // 你可以设置 alwaysShow: true，这样它就会忽略之前定义的规则，一直显示根路由
 * redirect: noRedirect             // 当设置 noRedirect 的时候该路由在面包屑导航中不可被点击
 * name:'router-name'               // 设定路由的名字，一定要填写不然使用<keep-alive>时会出现各种问题
 * query: '{"id": 1, "name": "ry"}' // 访问路由的默认传递参数
 * roles: ['admin', 'common']       // 访问路由的角色权限
 * permissions: ['a:a:a', 'b:b:b']  // 访问路由的菜单权限
 * meta : {
    noCache: true                   // 如果设置为true，则不会被 <keep-alive> 缓存(默认 false)
    title: 'title'                  // 设置该路由在侧边栏和面包屑中展示的名字
    icon: 'svg-name'                // 设置该路由的图标，对应路径src/assets/icons/svg
    breadcrumb: false               // 如果设置为false，则不会在breadcrumb面包屑中显示
    activeMenu: '/system/user'      // 当路由设置了该属性，则会高亮相对应的侧边栏。
  }
 */

// 公共路由
/**
 * 
 * 3. 公共路由 constantRoutes
定义了一系列无需权限验证即可访问的公共路由（如登录、注册、404页面等），以及一些基础布局下的路由（如首页）。

每个路由对象包含路径(path)、组件(component)、是否隐藏(hidden)、子路由(children)等属性。
特别注意的是，对于需要Layout布局的页面，使用了懒加载的方式引入组件，即component: () => import('@/views/xxx')。
 */
export const constantRoutes = [
  {
    path: '/redirect',
    component: Layout,
    hidden: true,
    children: [
      {
        path: '/redirect/:path(.*)',
        component: () => import('@/views/redirect')
      }
    ]
  },
 
  {
    path: '/login',
    component: () => import('@/views/login'),
    hidden: true
  },
  {
    path: '/register',
    component: () => import('@/views/register'),
    hidden: true
  },
  {
    path: '/404',
    component: () => import('@/views/error/404'),
    hidden: true
  },
  {
    path: '/401',
    component: () => import('@/views/error/401'),
    hidden: true
  },
  {
    path: '',
    component: Layout,
    redirect: 'index',
    children: [
      {
        path: 'index',
        component: () => import('@/views/index'),
        name: 'Index',
        meta: { title: '首页', icon: 'dashboard', affix: true }
      }
    ]
  },
/**
 * 1. path: ''
路径：这个顶级路由的path被设置为空字符串''。这意味着它将匹配基础路径（即根路径），通常是网站的主页面。
当用户访问应用的基础URL时，会触发这个路由。
2. component: Layout
组件：指定了一个顶层布局组件Layout。这通常是一个包含侧边栏、顶部导航等通用布局元素的组件。
每当这个路由被激活时，Layout组件会被渲染，并且其内部会根据子路由进一步渲染具体内容。
3. redirect: 'index'
重定向：设置了redirect属性为'index'，意味着如果直接访问父级路径（在这里是根路径），用户将会被自动重定向到子路由index。
这个功能常用于简化导航逻辑，确保用户总是能够到达预期的具体页面。
4. children: [...]
子路由数组：这里定义了一个子路由数组，包含了当前路由下的具体页面或视图。
在本例中，只有一个子路由，即首页

子路由详情：
path: 'index'
子路径：相对于父路径的相对路径名，这里是'index'。与父路径组合后形成完整的路径（在这种情况下，由于父路径为空，所以完整路径就是/index）。
component: () => import('@/views/index')
懒加载组件：使用动态导入语法来按需加载@/views/index组件。这种方式有助于优化首屏加载时间，因为只有当访问特定路由时才会加载对应的资源。
name: 'Index'
路由名称：给这个路由赋予了一个唯一的名称'Index'。命名路由可以方便地通过<router-link>或编程方式跳转到该路由。
meta: { title: '首页', icon: 'dashboard', affix: true }
元数据：提供了额外的信息，这些信息不会直接影响路由的行为，但可用于其他目的，如生成侧边栏菜单项。
title: 用于显示在侧边栏或者面包屑导航中的标题。
icon: 对应于侧边栏图标，通常是从一套预定义的图标集中选取。
affix: 如果设置为true，则表示该标签页固定在标签栏上，不会随关闭按钮而消失
 */

  {
    path: '/user',
    component: Layout,
    hidden: true,
    redirect: 'noredirect',
    children: [
      {
        path: 'profile',
        component: () => import('@/views/system/user/profile/index'),
        name: 'Profile',
        meta: { title: '个人中心', icon: 'user' }
      }
    ]
  }
]

// 动态路由，基于用户权限动态去加载
/**
 * 4. 动态路由 dynamicRoutes
定义了一些基于用户权限动态加载的路由。这些路由通常只对拥有特定权限的角色可见。

包含了诸如系统用户授权、角色授权、字典数据编辑等功能的路由。
同样采用了懒加载策略，并设置了相应的权限控制字段如permissions。
 */
export const dynamicRoutes = [
  {
    path: '/system/user-auth',
    component: Layout,
    hidden: true,
    permissions: ['system:user:edit'],
    children: [
      {
        path: 'role/:userId(\\d+)',
        component: () => import('@/views/system/user/authRole'),
        name: 'AuthRole',
        meta: { title: '分配角色', activeMenu: '/system/user' }
      }
    ]
  },
  {
    path: '/system/role-auth',
    component: Layout,
    hidden: true,
    permissions: ['system:role:edit'],
    children: [
      {
        path: 'user/:roleId(\\d+)',
        component: () => import('@/views/system/role/authUser'),
        name: 'AuthUser',
        meta: { title: '分配用户', activeMenu: '/system/role' }
      }
    ]
  },
  {
    path: '/system/dict-data',
    component: Layout,
    hidden: true,
    permissions: ['system:dict:list'],
    children: [
      {
        path: 'index/:dictId(\\d+)',
        component: () => import('@/views/system/dict/data'),
        name: 'Data',
        meta: { title: '字典数据', activeMenu: '/system/dict' }
      }
    ]
  },
  {
    path: '/monitor/job-log',
    component: Layout,
    hidden: true,
    permissions: ['monitor:job:list'],
    children: [
      {
        path: 'index/:jobId(\\d+)',
        component: () => import('@/views/monitor/job/log'),
        name: 'JobLog',
        meta: { title: '调度日志', activeMenu: '/monitor/job' }
      }
    ]
  },
  {
    path: '/tool/gen-edit',
    component: Layout,
    hidden: true,
    permissions: ['tool:gen:edit'],
    children: [
      {
        path: 'index/:tableId(\\d+)',
        component: () => import('@/views/tool/gen/editTable'),
        name: 'GenEdit',
        meta: { title: '修改生成配置', activeMenu: '/tool/gen' }
      }
    ]
  }
]

// 防止连续点击多次路由报错
/**
 * 5. 增强Vue Router的行为
为了防止连续点击相同路由导致的报错，重写了Router.prototype.push和Router.prototype.replace方法，
使其在捕获错误时返回错误本身而不是抛出异常。
 */
let routerPush = Router.prototype.push;
let routerReplace = Router.prototype.replace;
// push
Router.prototype.push = function push(location) {
  return routerPush.call(this, location).catch(err => err)
}
// replace
Router.prototype.replace = function push(location) {
  return routerReplace.call(this, location).catch(err => err)
}

/**
 * 6. 创建并导出路由实例
 * 设置了路由模式为history，这将移除URL中的#符号。
定义了滚动行为，在导航过程中始终滚动到页面顶部。
将初始路由表设定为constantRoutes，这意味着应用启动时只会加载这些公共路由
 */

export default new Router({
  mode: 'history', // 去掉url中的#
  scrollBehavior: () => ({ y: 0 }),
  routes: constantRoutes
})
